Added test script for ensuring docs are up to date. #672
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@hlopko Do you have a second to review this PR? |
hlopko
approved these changes
Apr 7, 2021
|
|
||
| _common_attrs = { | ||
| "aliases": attr.label_keyed_string_dict( | ||
| doc = _tidy(""" | ||
| doc = _tidy("""\ |
There was a problem hiding this comment.
Why not skip the first line if empty in _tidyand not require ? It seems fragile to remember to put \ there.
There was a problem hiding this comment.
Added support for ignoring first lines.
yagehu
pushed a commit
to yagehu/rules_rust
that referenced
this pull request
Apr 23, 2021
* Added test script for ensuring docs are up to date. * Fixed bug in doc attribute formatting. * Regenerate documentation * `_tidy` now ignores empty first lines * Updated comment * Regenerate documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Users should now see an error in their builds when they make a change which invalidates docs
Additionally, I've regenerated docs since they were out of date and fixed a bug in how docs were generated so we can correctly maintain indentations where desired.
Also I deleted the macos docs test since platform should have no impact on generating docs. This is purely a test of stardoc and the visibility of the bzl files which is platform agnostic.